Transforms forInboxBean


InboxListTransform

Formal Parameter Type Default Required Description
activeSortAscendingImage STRING sort_asc.gif false Specifies the image file name used by the transform to display the active sort ascending icon.
It is used to indicate that the history list has been sorted ascending by the current column header.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the active sort ascending, you would need to copy it to the images folder and then specify its name in this formal parameter.
activeSortDescendingImage STRING sort_desc.gif false Specifies the image file name used by the transform to display the active sort descending icon.
It is used to indicate that the history list has been sorted descending by the current column header.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the active sort descending, you would need to copy it to the images folder and then specify its name in this formal parameter.
allowDocumentExecutionOnDetails BOOLEAN true false Specifies whether the user will be able to execute documents from the document details page.
Allowed values:
  • true
  • false

Usage:
For example, if you allow to execute documents from the details page, then you would specify (true).
allowReportExecutionOnDetails BOOLEAN true false Specifies whether the user will be able to execute reports from the report details page.
Allowed values:
  • true
  • false

Usage:
For example, if you allow to execute reports from the details page, then you would specify (true).
appliesTo STRING   false

This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

Possible values for this property are bone ids, its usage depends on the page.
childImage STRING childArrow.gif false Specifies the image file name used by the transform to display the document's children reports.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image for this icon, you would need
to copy it to the images folder and then specify its name in this formal parameter.
collapseImage STRING contract.gif false Specifies the image file name used by the transform to display a collapsable object.
It is used to collapse the contents of the document object when its children reports are displayed.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the collapsable object, you would need to copy it to the images folder and then specify its name in this formal parameter.
contextMenus STRING   false

This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:

  1. The name of a <menu> defined in the pageConfig
  2. The path of an xml file with the context-menu definition

In both cases the xml defines the context-menus using <shortcut-list-set> tags. A <shortcut-list-set> represents a collection of <shortcut-list> tags. Each <shortcut-list> represents a single context-menu. Each <shortcut> represents a single option. Users can add/remove/modify <shortcut> to control the options displayed to the end user.
cssFile STRING   false CSS file that includes the style definition.
If defined, this file will be included as Link.
cssPrefix STRING   false Prefix to append to all css class names.
datamartErrorImage STRING DatamartError.gif false Specifies the image file name used by the transform to represent errors in a datamart object.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the errors in a datamart object, you would need to copy it to the images folder and then specify its name in this formal parameter.
datamartImage STRING datamart.gif false Specifies the image file name used by the transform to display the datamart report icon.
It is used to represent datamart reports.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to datamart report, you would need to copy it to the images folder and then specify its name in this formal parameter.
datamartScheduledImage STRING ScheduledDatamart.gif false Specifies the image file name used by the transform to represent scheduled datamart objects.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the scheduled datamart, you would need to copy it to the images folder and then specify its name in this formal parameter.
datamartWaitImage STRING document_wait.gif false Specifies the image file name used by the transform to display the running datamart icon.
This image will appear when the datamart is still running in the I-Server.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the datamart icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
debugErrorFlags INTEGER 65535 false Indicates which extra debug information to include in case of an error.
The flags are taken from the EnumWebAppDebugFlags enumeration.
debugFlags INTEGER 0 false Indicates which debug information to include.
The flags are taken from the EnumWebAppDebugFlags enumeration.
deleteTarget STRING   false Specifies the delete target page.
Usage:
For example, if you want to go to a specific target page when deleting an object,
then you would need to specify the name in this formal parameter.
documentErrorImage STRING DocError.gif false Specifies the image file name used by the transform to represent errors in a document object.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the errors in a document object, you would need to copy it to the images folder and then specify its name in this formal parameter.
documentImage STRING document.gif false Specifies the image file name used by the transform to display the document icon.
It is used to represent document objects.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the document icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
documentScheduledImage STRING ScheduledDocument.gif false Specifies the image file name used by the transform to represent scheduled document objects.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the scheduled document reports, you would need to copy it to the images folder and then specify its name in this formal parameter.
documentWaitImage STRING document_wait.gif false Specifies the image file name used by the transform to display the ruuning document icon.
This image will appear when the document object is still running in the I-Server.
The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
Usage:
For example, if you want to specify a different image to display the document icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
dragMode INTEGER 0 false Indicates the drag mode that the component to render will have.
Usage:
This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include:
  • 1 = can be dragged freely (floating)
  • 2 = can be docked
  • 3 = 1 + 2 (can be dragged freely & docked)
    		•
    expandImage STRING expand.gif false Specifies the image file name used by the transform to display an expandable object.
    It is used to expand the contents of the document object by showing its children reports..
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the expandable object, you would need to copy it to the images folder and then specify its name in this formal parameter.
    extraInput STRING   false Indicates any extra inputs to be included in the forms generated by the transform.
    extraUrl STRING   false Indicates any extra parameters to be included in the links generated by the transform.
    globalCssErrorMessage STRING error-message false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all error messages.
    globalCssErrorTitle STRING error-title false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all Error titles.
    graphErrorImage STRING graphError.gif false Specifies the image file name used by the transform to represent errors in a graph report.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the errors in a graph report, you would need to copy it to the images folder and then specify its name in this formal parameter.
    graphImage STRING graph.gif false Specifies the image file name used by the transform to display the graph icon.
    It is used to represent graph reports.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the graph icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
    graphScheduledImage STRING ScheduledGraph.gif false Specifies the image file name used by the transform to represent scheduled graph reports.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the scheduled graph reports, you would need to copy it to the images folder and then specify its name in this formal parameter.
    graphSnapshotImage STRING Graph2.gif false Specifies the image file name used by the transform to display the snapshot graph icon.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the snapshot graph icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
    graphWaitImage STRING graph_wait.gif false Specifies the image file name used by the transform to display the running graph icon.
    This image will appear when the graph report is still running in the I-Server.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the running graphs icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
    gridGraphImage STRING gridGraphIconForHelp.gif false Specifies the image file name used by the transform to display the grid-graph icon.
    It is used to represent grid-graph reports.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the grid-graph icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
    height STRING   false Indicates the default height of the component. If this is not a resizable component, this is the height used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
    iframeEnabled BOOLEAN false false Indicates whether the transform supports iframe manipulations.
    imgWait STRING ani_wait.gif false

    Deprecated. This value is not used anymore by the Transform as the wait image is included using css.


    Name of the image for the Processing icon on the Wait page.
    Allowed Values:
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    infoImage STRING info.gif false Specifies the image file name used by the transform to display the info icon.
    It is used to show the details of the report or document objects contained in the history list.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the info icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
    initialIndent INTEGER 0 false

    Deprecated. Indentation is not appended by Transforms anymore.


    Indicates the initial indentation of the HTML generated.
    levelFlag INTEGER 3199 false Specifies what information is displayed for each item in the inbox.
    The information may include object icon, name, status and other information. Multiple fields may be displayed at the same time.
    Which fields to show is indicated by a bitwise flag. This specifies fields like icon, name, status etc. This flag is used as a bit-wise flag.
    Allowed Values:
    • Icon = 1
    • Name = 2
    • Status = 4

    For complete list, see InboxListTransform.LEVEL_ICON, InboxListTransform.LEVEL_STATUS, InboxListTransform.LEVEL_TIME, InboxListTransform.LEVEL_DETAILS InboxListTransform.LEVEL_REMOVE, InboxListTransform.LEVEL_SORT_ICONS, InboxListTransform.LEVEL_WITHOUT_HEADER, InboxListTransform.LEVEL_WITHOUT_FOOTER, InboxListTransform.LEVEL_EXPORT_EXCEL, InboxListTransform.LEVEL_EXPORT_PDF, InboxListTransform.LEVEL_STATUS_WITHOUT_UNREAD, InboxListTransform.LEVEL_ALL
    Usage:
    For example, if you want to specify icon and status, then you would specify (1 + 4 = 5)
    maxItemCount INTEGER -1 false Specifies the maximum number of objects to be displayed in the history list.
    The default value is -1, which indicates that all the objects will be rendered.
    Usage:
    For example, if you want to show only 5 objects in the history list, you would need to set (5) in this formal parameter.
    orientation INTEGER 2 false Indicates the orientation the dialog to render will have.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = not docked
  • 1 = docked horizontally
  • 2 = docked vertically
    		•
    orientationsAllowed INTEGER 3 false Indicates the orientation modes allowed for the dialog to render.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = no orientations allowed
  • 1 = horizontal orientation allowed
  • 2 = vertical orientation allowed
  • 3 = 1 + 2 (both horiz & vert orientations are allowed)
    		•
    reportErrorImage STRING RepError.gif false Specifies the image file name used by the transform to represent errors in a grid report.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the errors in a grid report, you would need to copy it to the images folder and then specify its name in this formal parameter.
    reportImage STRING report2.gif false Specifies the image file name used by the transform to display the grid icon.
    It is used to represent grid reports.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the grid icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
    reportScheduledImage STRING ScheduledReport.gif false Specifies the image file name used by the transform to represent scheduled grid reports.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the scheduled grid reports, you would need to copy it to the images folder and then specify its name in this formal parameter.
    reportSnapshotImage STRING Report3.gif false Specifies the image file name used by the transform to display the snapshot grid icon.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the snapshot grid icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
    reportWaitImage STRING report_wait.gif false Specifies the image file name used by the transform to display the running grid icon.
    This image will appear when the grid report is still running in the I-Server.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the running grid icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
    resizeLevel INTEGER 0 false Indicates whether the component can be resized vertically/horizontally or both or none. Possible values are AbstractAppTransform.RESIZE_NONE, AbstractAppTransform.RESIZE_VERTICAL, AbstractAppTransform.RESIZE_HORIZONTAL, AbstractAppTransform.RESIZE_ALL
    rwDocumentErrorImage STRING rwdocument_error.gif false Specifies the image file name used by the transform to represent errors in a report writing document object.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the errors in a report writing document object, you would need to copy it to the images folder and then specify its name in this formal parameter.
    rwDocumentImage STRING rwdocument.gif false Specifies the image file name used by the transform to display the report writing document icon.
    It is used to represent document objects.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the report writing document icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
    rwDocumentScheduledImage STRING rwscheduled_document.gif false Specifies the image file name used by the transform to represent scheduled report writing document objects.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the scheduled report writing document reports, you would need to copy it to the images folder and then specify its name in this formal parameter.
    rwDocumentWaitImage STRING rwdocument_wait.gif false Specifies the image file name used by the transform to display the running report writing document icon.
    This image will appear when the document object is still running in the I-Server.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the report writing document icon, you would need to copy it to the images folder and then specify its name in this formal parameter.
    scriptClass STRING   false Holds the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component. A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
    By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.
    selectImage STRING SubscribeButton.gif false Specifies the image file name used by the transform to display options like export or PDF.
    It is used to indicate that certain options are available for the objects contained in the history list.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the options available, you would need to copy it to the images folder and then specify its name in this formal parameter.
    showDeleteForm BOOLEAN false false Specifies whether the transform will show the delete form.
    Allowed values:
    • true
    • false

    Usage:
    For example, if you want to show the delete form, then you would specify (true).
    sortAscendingImage STRING sort_row.gif false Specifies the image file name used by the transform to display the sort ascending icon.
    It is used to indicate that the history list can be sorted ascending by the current column header.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the sort ascending, you would need to copy it to the images folder and then specify its name in this formal parameter.
    sortDescendingImage STRING sort.gif false Specifies the image file name used by the transform to display the sort descending icon.
    It is used to indicate that the history list can be sorted descinding by the current column header.
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    Usage:
    For example, if you want to specify a different image to display the sort descending, you would need to copy it to the images folder and then specify its name in this formal parameter.
    type STRING   false

    This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

    Possible values for this property are bone ids, its usage depends on the page.
    useDHTML BOOLEAN true false Indicates whether to use DHTML on the output.
    If not set, the bean's OutputFormat() method will be used.
    width STRING   false Indicates the default width of the component. If this is not a resizable component, this is the width used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.